MasterFlowSchemasObject

Use this object to update the database schemas used in the data flow.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

itemId

The ID depends on the source: For Model files it is the item's system ID. For materialized/deployed models it is its materialized model ID.

Y

string

fromSchema

Current schema name.

Y

string

dataFlowNodeId

Data Flow node's ID. The ID can be found in the node's property pane within the 'description' card. For materialized/deployed model of direct query, this value can by blank.

-

string

schemaValidation

Define whether to check if the new schema exists, before changing.

-

UpdateSchemaValidation

toSchema

New schema name.

Y

string

*Required elements are only used for API parameters

Usages
  • /API2/dataSources/updateDataFlowNodeSchemas
  • /API3/dataSources/updateDataFlowNodeSchemas